org.springframework.web.util

Class AbstractUriTemplateHandler

java.lang.Object

org.springframework.web.util.AbstractUriTemplateHandler

All Implemented Interfaces:

UriTemplateHandler

Direct Known Subclasses:

DefaultUriTemplateHandler

public abstract class AbstractUriTemplateHandler
extends java.lang.Object
implements UriTemplateHandler

Abstract base class for UriTemplateHandler implementations.

Support setBaseUrl(java.lang.String) and setDefaultUriVariables(java.util.Map<java.lang.String, ?>) properties that should be relevant regardless of the URI template expand and encode mechanism used in sub-classes.

Since:

4.3

Author:

Rossen Stoyanchev

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	baseUrl
private java.util.Map<java.lang.String,java.lang.Object>	defaultUriVariables

Constructor Summary

Constructors

Constructor and Description
AbstractUriTemplateHandler()

Method Summary

Modifier and Type	Method and Description
java.net.URI	expand(java.lang.String uriTemplate, java.util.Map<java.lang.String,?> uriVariables) Expand the given URI template from a map of URI variables.
java.net.URI	expand(java.lang.String uriTemplate, java.lang.Object... uriVariables) Expand the given URI template from an array of URI variables.
protected abstract java.net.URI	expandInternal(java.lang.String uriTemplate, java.util.Map<java.lang.String,?> uriVariables) Actually expand and encode the URI template.
protected abstract java.net.URI	expandInternal(java.lang.String uriTemplate, java.lang.Object... uriVariables) Actually expand and encode the URI template.
java.lang.String	getBaseUrl() Return the configured base URL.
java.util.Map<java.lang.String,?>	getDefaultUriVariables() Return a read-only copy of the configured default URI variables.
private java.net.URI	insertBaseUrl(java.net.URI url) Insert a base URL (if configured) unless the given URL has a host already.
void	setBaseUrl(java.lang.String baseUrl) Configure a base URL to prepend URI templates with.
void	setDefaultUriVariables(java.util.Map<java.lang.String,?> defaultUriVariables) Configure default URI variable values to use with every expanded URI template.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

baseUrl

private java.lang.String baseUrl

defaultUriVariables

private final java.util.Map<java.lang.String,java.lang.Object> defaultUriVariables

Constructor Detail

AbstractUriTemplateHandler

public AbstractUriTemplateHandler()

Method Detail

setBaseUrl

public void setBaseUrl(java.lang.String baseUrl)

Configure a base URL to prepend URI templates with. The base URL must have a scheme and host but may optionally contain a port and a path. The base URL must be fully expanded and encoded which can be done via UriComponentsBuilder.

Parameters:

baseUrl - the base URL.

getBaseUrl

public java.lang.String getBaseUrl()

Return the configured base URL.

setDefaultUriVariables

public void setDefaultUriVariables(java.util.Map<java.lang.String,?> defaultUriVariables)

Configure default URI variable values to use with every expanded URI template. These default values apply only when expanding with a Map, and not with an array, where the Map supplied to expand(String, Map) can override the default values.

Parameters:

defaultUriVariables - the default URI variable values

Since:

4.3

getDefaultUriVariables

public java.util.Map<java.lang.String,?> getDefaultUriVariables()

Return a read-only copy of the configured default URI variables.

expand

public java.net.URI expand(java.lang.String uriTemplate,
                           java.util.Map<java.lang.String,?> uriVariables)

Description copied from interface: UriTemplateHandler

Expand the given URI template from a map of URI variables.

Specified by:

expand in interface UriTemplateHandler

Parameters:

uriTemplate - the URI template string

uriVariables - the URI variables

Returns:

the resulting URI

expand

public java.net.URI expand(java.lang.String uriTemplate,
                           java.lang.Object... uriVariables)

Description copied from interface: UriTemplateHandler

Expand the given URI template from an array of URI variables.

Specified by:

expand in interface UriTemplateHandler

Parameters:

uriTemplate - the URI template string

uriVariables - the URI variable values

Returns:

the resulting URI

expandInternal

protected abstract java.net.URI expandInternal(java.lang.String uriTemplate,
                                               java.util.Map<java.lang.String,?> uriVariables)

Actually expand and encode the URI template.

expandInternal

protected abstract java.net.URI expandInternal(java.lang.String uriTemplate,
                                               java.lang.Object... uriVariables)

Actually expand and encode the URI template.

insertBaseUrl

private java.net.URI insertBaseUrl(java.net.URI url)

Insert a base URL (if configured) unless the given URL has a host already.